﻿/*
 * DG (DG Gaming Engine)  - API
 * Copyright (C) 2004  Bob Marks (marksie531@yahoo.com)
 * http://code.google.com/p/dng-gaming
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
package com.dg.gaming.api.common.msg
{
	import nanoxml.XMLElement;
	import com.dg.gaming.api.common.TransmissionException;

	/**
	 * Communication class for a client requesting data.
	 *
	 * @author Bob Marks
	 * @version Alpha 0.2.3
	 */
	public class MsgRequestData extends MsgGameMessage
	{

		private var dataType:String=null;

		public static const XML_ATT_DATA_TYPE:String="dataType";


		/**
		 * Constructor which takes an XMLElement.
		 *
		 * @param message
		 * @throws TransmissionException
		 */
		public function MsgRequestData(dataType:String=null, message:XMLElement=null)
		{

			if (dataType != null)
			{
				// Set data type
				if (dataType == Msg.GAME || dataType == Msg.TABLE_LIST || dataType == Msg.USER_LIST)
				{

					// Set data type
					this.dataType=dataType;
				}
			}
			if (message != null)
				super(message);

			if (message != null)
			{
				this.dataType=message.getStringAttribute(XML_ATT_DATA_TYPE);
			}
		}

		/**
		 * Return the data type that the user wishes to receive.
		 *
		 * @return   Data type.
		 */
		public function getDataType():String
		{
			return dataType;
		}

		/**
		 * Flatten the object into an XMLElement.
		 *
		 * @see com.dg.gaming.api.common.msg.ITransmittable#flatten()
		 */
		public override function flatten():XMLElement
		{
			var message:XMLElement=super.flattenWithName(Msg.REQUEST_DATA);
			message.setAttribute(XML_ATT_DATA_TYPE, dataType);

			return message;
		}

	}
}